home *** CD-ROM | disk | FTP | other *** search
/ Clickx 115 / Clickx 115.iso / software / tools / windows / tails-i386-0.16.iso / live / filesystem.squashfs / usr / lib / perl5 / Glib / Log.pod < prev    next >
Encoding:
Text File  |  2012-02-20  |  3.9 KB  |  235 lines
  1. =head1 NAME
  2.  
  3. Glib::Log -  A flexible logging mechanism
  4.  
  5. =cut
  6.  
  7. =for object Glib::Log A flexible logging mechanism
  8. =cut
  9.  
  10. =for object Glib::Log
  11. =cut
  12.  
  13. =for object Glib::Log
  14. =cut
  15.  
  16.  
  17.  
  18.  
  19. =head1 METHODS
  20.  
  21. =head2 scalar = Glib::Log-E<gt>B<set_always_fatal> ($fatal_mask)
  22.  
  23. =over
  24.  
  25. =item * $fatal_mask (scalar) 
  26.  
  27. =back
  28.  
  29. =head2 Glib-E<gt>B<critical> ($domain, $message)
  30.  
  31. =over
  32.  
  33. =item * $domain (string or undef) 
  34.  
  35. =item * $message (string) 
  36.  
  37. =back
  38.  
  39. =head2 Glib::Log::default_handler ($log_domain, $log_level, $message, ...)
  40.  
  41. =over
  42.  
  43. =item * $log_domain (string) 
  44.  
  45. =item * $log_level (scalar) 
  46.  
  47. =item * $message (string) 
  48.  
  49. =item * ... (list) possible "userdata" argument ignored
  50.  
  51. =back
  52.  
  53. The arguments are the same as taken by the function for set_handler or
  54. set_default_handler.
  55.  
  56. =head2 prev_log_func = Glib->B<set_default_handler> ($log_func, $user_data)
  57.  
  58. =over
  59.  
  60. =item * $log_func (subroutine) handler function or undef
  61.  
  62. =item * $user_data (scalar) 
  63.  
  64. =back
  65.  
  66. Install log_func as the default log handler.  log_func is called for
  67. anything which doesn't otherwise have a handler (either
  68. Glib::Log->set_handler, or the L<Glib::xsapi|Glib::xsapi>
  69. gperl_handle_logs_for),
  70.  
  71.     &$log_func ($log_domain, $log_levels, $message, $user_data)
  72.  
  73. where $log_domain is a string, and $log_levels is a
  74. Glib::LogLevelFlags of level and flags being reported.
  75.  
  76. If log_func is \&Glib::Log::default_handler or undef then Glib's
  77. default handler is set.
  78.  
  79. The return value from C<set_default_handler> is the previous handler.
  80. This is \&Glib::Log::default_handler for Glib's default, otherwise a
  81. Perl function previously installed.  If the handler is some other
  82. non-Perl function then currently the return is undef, but perhaps that
  83. will change to some wrapped thing, except that without associated
  84. userdata there's very little which could be done with it (it couldn't
  85. be reinstalled later without its userdata).
  86.  
  87. Since: glib 2.6
  88.  
  89. =head2 Glib-E<gt>B<error> ($domain, $message)
  90.  
  91. =over
  92.  
  93. =item * $domain (string or undef) 
  94.  
  95. =item * $message (string) 
  96.  
  97. =back
  98.  
  99. =head2 scalar = Glib::Log-E<gt>B<set_fatal_mask> ($log_domain, $fatal_mask)
  100.  
  101. =over
  102.  
  103. =item * $log_domain (string) 
  104.  
  105. =item * $fatal_mask (scalar) 
  106.  
  107. =back
  108.  
  109. =head2 integer = Glib::Log-E<gt>B<set_handler> ($log_domain, $log_levels, $log_func, $user_data=undef)
  110.  
  111. =over
  112.  
  113. =item * $log_domain (string or undef) name of the domain to handle with this callback.
  114.  
  115. =item * $log_levels (Glib::LogLevelFlags) log levels to handle with this callback
  116.  
  117. =item * $log_func (subroutine) handler function
  118.  
  119. =item * $user_data (scalar) 
  120.  
  121. =back
  122.  
  123.  
  124.  
  125.  
  126.  
  127. $log_func will be called as
  128.  
  129.     &$log_func ($log_domain, $log_levels, $message, $user_data);
  130.  
  131. where $log_domain is the name requested and $log_levels is a
  132. Glib::LogLevelFlags of level and flags being reported.
  133.  
  134. =head2 Glib-E<gt>B<log> ($log_domain, $log_level, $message)
  135.  
  136. =over
  137.  
  138. =item * $log_domain (string or undef) 
  139.  
  140. =item * $log_level (scalar) 
  141.  
  142. =item * $message (string) 
  143.  
  144. =back
  145.  
  146. =head2 Glib-E<gt>B<message> ($domain, $message)
  147.  
  148. =over
  149.  
  150. =item * $domain (string or undef) 
  151.  
  152. =item * $message (string) 
  153.  
  154. =back
  155.  
  156. =head2 Glib::Log-E<gt>B<remove_handler> ($log_domain, $handler_id)
  157.  
  158. =over
  159.  
  160. =item * $log_domain (string or undef) 
  161.  
  162. =item * $handler_id (integer) as returned by C<set_handler>
  163.  
  164. =back
  165.  
  166.  
  167.  
  168. =head2 Glib-E<gt>B<warning> ($domain, $message)
  169.  
  170. =over
  171.  
  172. =item * $domain (string or undef) 
  173.  
  174. =item * $message (string) 
  175.  
  176. =back
  177.  
  178.  
  179.  
  180. =cut
  181.  
  182.  
  183. =head1 ENUMS AND FLAGS
  184.  
  185. =head2 flags Glib::LogLevelFlags
  186.  
  187.  
  188.  
  189. =over
  190.  
  191. =item * 'recursion' / 'G_LOG_FLAG_RECURSION'
  192.  
  193. =item * 'fatal' / 'G_LOG_FLAG_FATAL'
  194.  
  195. =item * 'error' / 'G_LOG_LEVEL_ERROR'
  196.  
  197. =item * 'critical' / 'G_LOG_LEVEL_CRITICAL'
  198.  
  199. =item * 'warning' / 'G_LOG_LEVEL_WARNING'
  200.  
  201. =item * 'message' / 'G_LOG_LEVEL_MESSAGE'
  202.  
  203. =item * 'info' / 'G_LOG_LEVEL_INFO'
  204.  
  205. =item * 'debug' / 'G_LOG_LEVEL_DEBUG'
  206.  
  207. =item * 'fatal-mask' / 'G_LOG_FATAL_MASK'
  208.  
  209. =back
  210.  
  211.  
  212.  
  213.  
  214. =cut
  215.  
  216.  
  217. =head1 SEE ALSO
  218.  
  219. L<Glib>
  220.  
  221.  
  222. =cut
  223.  
  224.  
  225. =head1 COPYRIGHT
  226.  
  227. Copyright (C) 2003-2011 by the gtk2-perl team.
  228.  
  229. This software is licensed under the LGPL.  See L<Glib> for a full notice.
  230.  
  231.  
  232.  
  233. =cut
  234.  
  235.